﻿/* 
* Copyright (c) 2010, The University of Texas at Austin
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, 
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, 
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, 
* this list of conditions and the following disclaimer in the documentation and/or other materials 
* provided with the distribution.
*
* Neither the name of The University of Texas at Austin nor the names of its contributors may be 
* used to endorse or promote products derived from this software without specific prior written 
* permission.
* 
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR 
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 
* THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

using System.Collections.Generic;
using System.Windows;
using Bio.Data.Interfaces;
using Bio.Views.Structure.Editor.Internal.Editing;
using Bio.Views.Structure.Editor.Internal.Rendering.Interfaces;

namespace Bio.Views.Structure.Editor.Internal.Selection.Interfaces
{
    /// <summary>
    /// Using a facade pattern here. The base class (StructureElementSelectionGroupBase) implements the global methods and leaves
    /// those methods not applicable to all derived classes as virtual with empty implementation.
    /// Individually derived selection groups override the applicable editing methods.
    /// </summary>
    public interface IStructureElementSelectionGroup : IDraggableSecondaryStructureElement, IRotateableSecondaryStructureElement
    {
        int ID { get; }
        IStructureElementVisualComponent Visual { get; }

        bool HitTestElement(Point location);
        void SelectElement();
        void DeselectElement();
        void MakeElementSelectable();
        void MakeElementUnselectable();

        void DeleteSelection();

        void MoveBy(Point delta);
        void MoveTo(Point location);
        void RotateBy(double angleInDegrees);
        void RotateTo(double angleInDegrees);
        void ResizeTo(double newWidth, double newPadding);
        void EditProperties(StructureElementPropertyChangeSet changeSet, List<IBioSymbol> filter);

        void SnapHelixToOpeningBasePair();
        void SnapHelixToClosingBasePair();
        void SnapLoop();
    }
}
